Matrix

MSLUMatrixLoad

• Syntax:

  double MSLUMatrixLoad(double FileID);
  

  FileID: ID of file containing description of matrix.
  

• Description:

  Creates new matrix with description as specified in file "MSLUMatrix.<FileID>.txt".

• Returns:

  Unique matrix identifier.

MSLUMatrixRemove

• Syntax:

  double MSLUMatrixRemove(double ID);
  

  ID: Matrix identifier.

• Description:

  Remove matrix with identifier "ID".

• Returns:

  Always returns 0.

MSLUMatrixRemoveAll

• Syntax:

  double MSLUMatrixRemoveAll(void);
  

• Description:

  Remove all matrices.

• Returns:

  Always returns 0.

MSLUMatrixGetNoRows

• Syntax:

  double MSLUMatrixGetNoRows(double ID);
  

  ID: Matrix identifier.
  

• Description:

  Get number of rows in matrix (not including first (header) row).

• Returns:

  Number of rows.

MSLUMatrixGetNoColumns

• Syntax:

  double MSLUMatrixGetNoColumns(double ID);
  

  ID: Matrix identifier.
  

• Description:

  Get number of columns in matrix (not including first (header) column).

• Returns:

  Number of columns.

MSLUMatrixGetValue1

• Syntax:

  double MSLUMatrixGetValue1(double ID, double i, double j);
  

  ID: Matrix identifier.
  i: Row number.
  j: Column number.

• Description:

  Get matrix value at position (i,j). i should not be less than 0, and smaller than "NoRows". j should be no less than 0, and smaller than "NoColumns".

• Returns:

  Matrix value.

MSLUMatrixGetValue2

• Syntax:

  double MSLUMatrixGetValue2(double ID, double X, double ColumnNo, double Interpolated, double Extrapolated);
  

  ID: Matrix identifier.
  X: X-coordinate of value that is to be retrieved.
  ColumnNo: Number of column that contains Y-values.
  Interpolated: Indicates whether 1st order interpolation is to be performed.
  Extrapolated: Indicates whether 1st order extrapolation is to be performed (either using first 2, or last 2 points).

• Description:

  Retrieves a value from a matrix referred to be its identifier.

• Returns:

  Matrix value.

MSLUMatrixRead

• Syntax:

  double MSLUMatrixRead(double* Matrix, double NoRows, double NoColumns, double FileID);
  

  Matrix: Matrix.
  NoRows: Number of rows.
  NoColumns: Number of columns.
  FileID: ID of file that is to be read.

• Description:

  Read matrix data from a file named "MSLUMatrix.<FileID>.txt" and store it in the container pointed to by "Matrix".

• Returns:

  Always returns 0.

MSLUMatrixWrite

• Syntax:

  double MSLUMatrixWrite(double* Matrix, double NoRows, double NoColumns, double FileID, double Mode);
  

  Matrix: Matrix.
  NoRows: Number of rows.
  NoColumns: Number of columns.
  FileID: ID of file that is to be written.
  Mode: Determines the nature of the output file.

• Description:

  Write matrix data stored in the container pointed to by "Matrix" to a file named "MSLUMatrix.<FileID>.txt". If "Mode" is set to 0 a plain data file is written (without headers), if it is set to 1 a Tornado data file is written, and if it is set to 2 a file is written that can be visualized by GNUPlot.

• Returns:

  Always returns 0.

MSLUMatrixGetValue3

• Syntax:

  double MSLUMatrixGetValue3(double* Matrix, double NoRows, double NoColumns, double x, double ColumnNo, double Interpolated, double Extrapolated);
  

  Matrix: Matrix.
  NoRows: Number of rows.
  NoColumns: Number of columns.
  X: X-coordinate of value that is to be retrieved.
  ColumnNo: Number of column that contains Y-values.
  Interpolated: Indicates whether 1st order interpolation is to be performed.
  Extrapolated: Indicates whether 1st order extrapolation is to be performed (either using first 2, or last 2 points).

• Description:

  Retrieves a value from a matrix container pointed to by "Matrix".

• Returns:

  Matrix value.

MSLUMatrixInvert

• Syntax:

  double MSLUMatrixInvert(double* Src, double* Dest, double NoRows);
  

  Src: Source matrix.
  Dest: Destination matrix.
  NoRows: Number of rows.

• Description:

  Inverts square matrix pointed to by "Src" and stores the result in "Dest".

• Returns:

  Always returns 0.

MSLUMatrixLinSolve

• Syntax:

  double MSLUMatrixLinSolve(double* A, double* B, double* X, double NoRows);
  

  A: Matrix containing coefficients.
  B: Matrix containing right-hand sides.
  X: Matrix containing unknowns.
  NoRows: Number of rows.

• Description:

  Solves the linear system A * X = B. A and X are square matrices. B is a column matrix.

• Returns:

  Always returns 0.